home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il_c / ilTimer.z / ilTimer
Encoding:
Text File  |  2002-10-03  |  5.0 KB  |  133 lines
  1.  
  2.  
  3.  
  4. iiiillllTTTTiiiimmmmeeeerrrr((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllTTTTiiiimmmmeeeerrrr((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllTTTTiiiimmmmeeeerrrr - a high-resolution interval timer
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      This is a base class
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <il/ilCdefs.h>
  16.  
  17. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      ilTimer provides an interface to the high-resolution interval timer. On
  19.      most SGI machines this has a resolution of 1 usec or better.  The
  20.      simplest way to use this is:
  21.  
  22.           ilLiveTimer timer;                // start timing
  23.           float secondsElapsed = timer.getSeconds();  // get elapsed time
  24.  
  25.      You can also explicitly turn the timer on/off:
  26.  
  27.           ilTimer timer; // timer doesn't start running
  28.           for (int i = 0; i < loopCount; i++) {
  29.               timer.start();  // start a new interval
  30.               .
  31.               .
  32.               timer.stop();   // end the interval
  33.               float secondsElapsed = timer.getSeconds();  // get elapsed time
  34.  
  35.           }
  36.  
  37.  
  38. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  39.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  40.  
  41.           ilTimer* ilTimerCreate()
  42.           ilTimer* ilLiveTimerCreate()
  43.  
  44.      IIIInnnntttteeeerrrrvvvvaaaallll ssssppppeeeeccccffffiiiiccccaaaattttiiiioooonnnn
  45.  
  46.           void ilTimerStart(ilTimer *obj)
  47.           void ilTimerStop(ilTimer *obj)
  48.  
  49.      QQQQuuuueeeerrrryyyy mmmmeeeetttthhhhooooddddssss
  50.  
  51.           int ilTimerIsRunning(ilTimer *obj)
  52.           float ilTimerGetSeconds(ilTimer *obj)
  53.  
  54.      GGGGlllloooobbbbaaaallll ttttiiiimmmmeeee ssssttttaaaammmmppppssss
  55.  
  56. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  57.      iiiillllTTTTiiiimmmmeeeerrrr(((())))
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiillllTTTTiiiimmmmeeeerrrr((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllTTTTiiiimmmmeeeerrrr((((3333))))
  71.  
  72.  
  73.  
  74.           ilTimer* ilTimerCreate()
  75.           ilTimer* ilLiveTimerCreate()
  76.  
  77.  
  78.           Construct a timer. The timer is not running when first contructed.
  79.           An ilLiveTimer is identical to ilTimer except that is running upon
  80.           construction.
  81.  
  82.      ggggeeeettttSSSSeeeeccccoooonnnnddddssss(((())))
  83.  
  84.           float ilTimerGetSeconds(ilTimer *obj)
  85.  
  86.  
  87.           If the timer is running this method returns the elapsed time since
  88.           the last call to ssssttttaaaarrrrtttt() and leaves the timer runnging. If the timer
  89.           has been stopped then it returns the time interval between the last
  90.           pair of calls to ssssttttaaaarrrrtttt() and ssssttttoooopppp(). If the timer has never been
  91.           started, -1 will be returned.
  92.  
  93.      iiiissssRRRRuuuunnnnnnnniiiinnnngggg(((())))
  94.  
  95.           int ilTimerIsRunning(ilTimer *obj)
  96.  
  97.  
  98.           This method returns true if the timer is currently running.
  99.  
  100.      ssssttttaaaarrrrtttt(((())))
  101.  
  102.           void ilTimerStart(ilTimer *obj)
  103.  
  104.  
  105.           The ssssttttaaaarrrrtttt() and ssssttttoooopppp() methods provide explict control over the
  106.           beginning and ending of the interval to be measured. The methods can
  107.           be called (in pairs) as many times as desired on a single timer;
  108.           thus an ilTimer can be reused to time multiple (non-overlapping)
  109.           intervals.
  110.  
  111.      ssssttttoooopppp(((())))
  112.  
  113.           void ilTimerStop(ilTimer *obj)
  114.  
  115.  
  116.           See the description of the ssssttttaaaarrrrtttt() method.
  117.  
  118. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  119.      ilTimeoutTimer(3)
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.